---
title: Workbook Data Structure
icon: NotebookTabs
---

## IWorkbookData

[`IWorkbookData`](https://reference.univer.ai/en-US/interfaces/IWorkbookData) represents the snapshot of a workbook in Univer Sheet.

### Properties

| Property | Type | Description |
|----------|------|-------------|
| id | `string` | Unique identifier of the Univer Sheets. |
| name | `string` | Name of the Univer Sheets. |
| appVersion | `string` | Version of the Univer model definition. |
| locale | `LocaleType` | Locale of the document. |
| styles | `Record<string, Nullable<IStyleData>>` | Style references for the workbook. |
| sheetOrder | `string[]` | Array of sheet IDs representing the order of worksheets. |
| sheets | `{ [sheetId: string]: Partial<IWorksheetData> }` | Record containing data for each worksheet. |
| resources? | `IResources` | Store the data of plugins |

### Example

```typescript
const workbookData: IWorkbookData = {
  id: 'unique-workbook-id',
  name: 'My Workbook',
  appVersion: '0.10.2',
  locale: LocaleType.EN_US,
  styles: { /* style definitions */ },
  sheetOrder: ['sheet1', 'sheet2'],
  sheets: {
    sheet1: { /* sheet data */ },
    sheet2: { /* sheet data */ },
  },
}
```

### Usage

IWorkbookData is the object used to store data in Univer Sheets. It is mainly used for:

1. [Creating a Univer Sheets using IWorkbookData](/guides/sheets/features/core/sheets-api#create-worksheet)
2. [Saving IWorkbookData from Univer Sheets](/guides/sheets/features/core/sheets-api#get-workbook-data)

`resources` property is used to store plugin data. Go to [Plugin Custom Model](/guides/recipes/tutorials/custom-model)
